Bind to the sourcing catalog — the dropship "add to store" write.
curl --request POST \
--url https://api.platformdtc.com/api/v1/products/{product_id}/catalog-link \
--header 'Content-Type: application/json' \
--header 'X-Agent-Key: <api-key>' \
--data '
{
"spu_id": "<string>",
"bundle_type": "<string>",
"is_additive": false,
"catalog_variants": [
{
"catalog_variant_id": "<string>",
"catalog_product_id": "<string>",
"quantity": 1
}
],
"variant_relation": [
{
"product_variant_id": "<string>",
"catalog_variant_id": "<string>"
}
]
}
'import requests
url = "https://api.platformdtc.com/api/v1/products/{product_id}/catalog-link"
payload = {
"spu_id": "<string>",
"bundle_type": "<string>",
"is_additive": False,
"catalog_variants": [
{
"catalog_variant_id": "<string>",
"catalog_product_id": "<string>",
"quantity": 1
}
],
"variant_relation": [
{
"product_variant_id": "<string>",
"catalog_variant_id": "<string>"
}
]
}
headers = {
"X-Agent-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Agent-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
spu_id: '<string>',
bundle_type: '<string>',
is_additive: false,
catalog_variants: [{catalog_variant_id: '<string>', catalog_product_id: '<string>', quantity: 1}],
variant_relation: [{product_variant_id: '<string>', catalog_variant_id: '<string>'}]
})
};
fetch('https://api.platformdtc.com/api/v1/products/{product_id}/catalog-link', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.platformdtc.com/api/v1/products/{product_id}/catalog-link",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'spu_id' => '<string>',
'bundle_type' => '<string>',
'is_additive' => false,
'catalog_variants' => [
[
'catalog_variant_id' => '<string>',
'catalog_product_id' => '<string>',
'quantity' => 1
]
],
'variant_relation' => [
[
'product_variant_id' => '<string>',
'catalog_variant_id' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Agent-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.platformdtc.com/api/v1/products/{product_id}/catalog-link"
payload := strings.NewReader("{\n \"spu_id\": \"<string>\",\n \"bundle_type\": \"<string>\",\n \"is_additive\": false,\n \"catalog_variants\": [\n {\n \"catalog_variant_id\": \"<string>\",\n \"catalog_product_id\": \"<string>\",\n \"quantity\": 1\n }\n ],\n \"variant_relation\": [\n {\n \"product_variant_id\": \"<string>\",\n \"catalog_variant_id\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Agent-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.platformdtc.com/api/v1/products/{product_id}/catalog-link")
.header("X-Agent-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"spu_id\": \"<string>\",\n \"bundle_type\": \"<string>\",\n \"is_additive\": false,\n \"catalog_variants\": [\n {\n \"catalog_variant_id\": \"<string>\",\n \"catalog_product_id\": \"<string>\",\n \"quantity\": 1\n }\n ],\n \"variant_relation\": [\n {\n \"product_variant_id\": \"<string>\",\n \"catalog_variant_id\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.platformdtc.com/api/v1/products/{product_id}/catalog-link")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Agent-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"spu_id\": \"<string>\",\n \"bundle_type\": \"<string>\",\n \"is_additive\": false,\n \"catalog_variants\": [\n {\n \"catalog_variant_id\": \"<string>\",\n \"catalog_product_id\": \"<string>\",\n \"quantity\": 1\n }\n ],\n \"variant_relation\": [\n {\n \"product_variant_id\": \"<string>\",\n \"catalog_variant_id\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"product_id": "<string>",
"catalog_product_id": "<string>",
"bind_status": 1,
"linked_variant_count": 123,
"total_variant_count": 123,
"variant_links": [
{
"product_variant_id": "<string>",
"bundle_id": "<string>",
"items": [
{}
]
}
]
},
"meta": {}
}{
"success": false,
"message": "<string>",
"error_code": "NOT_FOUND",
"errors": {}
}{
"success": false,
"message": "<string>",
"error_code": "NOT_FOUND",
"errors": {}
}{
"success": false,
"message": "<string>",
"error_code": "NOT_FOUND",
"errors": {}
}products
Bind to the sourcing catalog — the dropship "add to store" write.
POST
/
api
/
v1
/
products
/
{product_id}
/
catalog-link
Bind to the sourcing catalog — the dropship "add to store" write.
curl --request POST \
--url https://api.platformdtc.com/api/v1/products/{product_id}/catalog-link \
--header 'Content-Type: application/json' \
--header 'X-Agent-Key: <api-key>' \
--data '
{
"spu_id": "<string>",
"bundle_type": "<string>",
"is_additive": false,
"catalog_variants": [
{
"catalog_variant_id": "<string>",
"catalog_product_id": "<string>",
"quantity": 1
}
],
"variant_relation": [
{
"product_variant_id": "<string>",
"catalog_variant_id": "<string>"
}
]
}
'import requests
url = "https://api.platformdtc.com/api/v1/products/{product_id}/catalog-link"
payload = {
"spu_id": "<string>",
"bundle_type": "<string>",
"is_additive": False,
"catalog_variants": [
{
"catalog_variant_id": "<string>",
"catalog_product_id": "<string>",
"quantity": 1
}
],
"variant_relation": [
{
"product_variant_id": "<string>",
"catalog_variant_id": "<string>"
}
]
}
headers = {
"X-Agent-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Agent-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
spu_id: '<string>',
bundle_type: '<string>',
is_additive: false,
catalog_variants: [{catalog_variant_id: '<string>', catalog_product_id: '<string>', quantity: 1}],
variant_relation: [{product_variant_id: '<string>', catalog_variant_id: '<string>'}]
})
};
fetch('https://api.platformdtc.com/api/v1/products/{product_id}/catalog-link', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.platformdtc.com/api/v1/products/{product_id}/catalog-link",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'spu_id' => '<string>',
'bundle_type' => '<string>',
'is_additive' => false,
'catalog_variants' => [
[
'catalog_variant_id' => '<string>',
'catalog_product_id' => '<string>',
'quantity' => 1
]
],
'variant_relation' => [
[
'product_variant_id' => '<string>',
'catalog_variant_id' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Agent-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.platformdtc.com/api/v1/products/{product_id}/catalog-link"
payload := strings.NewReader("{\n \"spu_id\": \"<string>\",\n \"bundle_type\": \"<string>\",\n \"is_additive\": false,\n \"catalog_variants\": [\n {\n \"catalog_variant_id\": \"<string>\",\n \"catalog_product_id\": \"<string>\",\n \"quantity\": 1\n }\n ],\n \"variant_relation\": [\n {\n \"product_variant_id\": \"<string>\",\n \"catalog_variant_id\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Agent-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.platformdtc.com/api/v1/products/{product_id}/catalog-link")
.header("X-Agent-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"spu_id\": \"<string>\",\n \"bundle_type\": \"<string>\",\n \"is_additive\": false,\n \"catalog_variants\": [\n {\n \"catalog_variant_id\": \"<string>\",\n \"catalog_product_id\": \"<string>\",\n \"quantity\": 1\n }\n ],\n \"variant_relation\": [\n {\n \"product_variant_id\": \"<string>\",\n \"catalog_variant_id\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.platformdtc.com/api/v1/products/{product_id}/catalog-link")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Agent-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"spu_id\": \"<string>\",\n \"bundle_type\": \"<string>\",\n \"is_additive\": false,\n \"catalog_variants\": [\n {\n \"catalog_variant_id\": \"<string>\",\n \"catalog_product_id\": \"<string>\",\n \"quantity\": 1\n }\n ],\n \"variant_relation\": [\n {\n \"product_variant_id\": \"<string>\",\n \"catalog_variant_id\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"product_id": "<string>",
"catalog_product_id": "<string>",
"bind_status": 1,
"linked_variant_count": 123,
"total_variant_count": 123,
"variant_links": [
{
"product_variant_id": "<string>",
"bundle_id": "<string>",
"items": [
{}
]
}
]
},
"meta": {}
}{
"success": false,
"message": "<string>",
"error_code": "NOT_FOUND",
"errors": {}
}{
"success": false,
"message": "<string>",
"error_code": "NOT_FOUND",
"errors": {}
}{
"success": false,
"message": "<string>",
"error_code": "NOT_FOUND",
"errors": {}
}Authorizations
Service-account key, format sq_agt_*. Carries least-privilege scopes.
Headers
Optional on the products domain API — absent, the request simply executes. When present, a replay with the same body returns the cached response and a different body returns 409. Send it on every write anyway.
Maximum string length:
200Target store; required when the key is bound to multiple stores.
Path Parameters
Body
application/json
spu_id or a non-empty catalog_variants is required.
Required string length:
1 - 64Maximum string length:
32Keep existing links instead of replacing them. Also accepted as isAdditive.
Maximum array length:
200Show child attributes
Show child attributes
Maximum array length:
200Show child attributes
Show child attributes